feat(toolkit-lib): network detector #926
Conversation
kaizencc
had a problem deploying
to
integ-approval
GitHub Actions
Failure
| // Check connectivity before attempting network request | ||
| const hasConnectivity = await NetworkDetector.hasConnectivity(this.agent); | ||
| if (!hasConnectivity) { | ||
| throw new ToolkitError('No internet connectivity detected'); |
There was a problem hiding this comment.
Is throwing the right thing here? Is that error caught elsewhere? Asking because Notices should just silently fail. A comment might help.
There was a problem hiding this comment.
this is the right thing to do here. we are throwing errors in web-data-source on failures and expecting to swallow them elsewhere (which we do)
There was a problem hiding this comment.
[non-blocking] Since this pattern will be very common (get the result, check whether it's true and throw an error if not), we could also have a method that takes a callback and does this for you:
return NetworkDetector.ifConnected(async() => {...});
kaizencc
requested a deployment
to
integ-approval
GitHub Actions
Waiting
kaizencc
had a problem deploying
to
integ-approval
GitHub Actions
Failure
| ); | ||
| }); | ||
|
|
||
| test('skips request when no connectivity detected', async () => { |
There was a problem hiding this comment.
this is the true result: we do not ping the telemetry endpoint in environments without internet access
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #926 +/- ##
==========================================
+ Coverage 84.17% 84.50% +0.33%
==========================================
Files 71 71
Lines 10437 10444 +7
Branches 1334 1349 +15
==========================================
+ Hits 8785 8826 +41
+ Misses 1611 1577 -34
Partials 41 41
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
kaizencc
requested a deployment
to
integ-approval
GitHub Actions
Waiting
kaizencc
temporarily deployed
to
integ-approval
GitHub Actions
Inactive
Signed-off-by: github-actions <[email protected]>
aws-cdk-automation
had a problem deploying
to
integ-approval
GitHub Actions
Failure
aws-cdk-automation
had a problem deploying
to
integ-approval
GitHub Actions
Failure
kaizencc
had a problem deploying
to
integ-approval
GitHub Actions
Failure
Signed-off-by: github-actions <[email protected]>
aws-cdk-automation
requested a deployment
to
integ-approval
GitHub Actions
Waiting
kaizencc
temporarily deployed
to
integ-approval
GitHub Actions
Inactive
5 participants
this PR implements a connectivity detector that performs a HEAD request to the notices endpoint, with a timeout of 1 hour. before making any subsequent network calls, (including GET notices and PUT telemetry) we check to see if we have already determined the network to be disconnected. in those cases, we skip subsequent calls.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license